chore: cleanup temporary scripts and add autocorrect config#94
chore: cleanup temporary scripts and add autocorrect config#94xihale merged 1 commit intozigcc:mainfrom
Conversation
Summary of ChangesHello @xihale, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request streamlines the project's development workflow by removing a set of ad-hoc content processing scripts and integrating Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a good cleanup effort, removing several temporary scripts and introducing configuration for the autocorrect tool to standardize formatting. The new configuration files for autocorrect are well-defined. My main feedback concerns the removal of the scripts. I've pointed out a potential regression in functionality from removing format.ts without a clear replacement for its ID formatting capabilities. I've also left a note on best practices regarding synchronous file I/O in one of the other removed scripts for future reference.
I am having trouble creating individual review comments. Click here to see my feedback.
format.ts (1-153)
The removal of this script eliminates the automated translation and formatting of heading IDs. This was a useful feature for ensuring consistent, URL-friendly IDs, especially for content written in Chinese. While this may be a temporary script that has served its purpose, its removal could be a regression in developer experience for content authors. If this functionality is not replaced by another tool, it introduces a manual process that is prone to inconsistency. Please consider if this functionality should be retained, perhaps in a more integrated form, to support ongoing content creation.
convert_figure_to_image_link.js (7-18)
The use of synchronous file system methods like fs.readdirSync and fs.statSync is generally discouraged in Node.js as it blocks the event loop. For future scripts, consider using the asynchronous versions from the fs.promises API with async/await for better performance and to follow best practices, even for command-line tools.
1 participant
No description provided.